From 03806f3ad08d97efa1b90ba50365d53bce1bd93e Mon Sep 17 00:00:00 2001
From: oliskoli <oliskoli>
Date: Fri, 25 May 2007 22:02:05 +0000
Subject: [PATCH] Add doc's for "garmin_gpi" file format.

---
 xmldoc/formats/garmin_gpi.xml                 | 23 +++++++++++++++++++
 xmldoc/formats/options/garmin_gpi-bitmap.xml  | 13 +++++++++++
 .../formats/options/garmin_gpi-category.xml   |  9 ++++++++
 xmldoc/formats/options/garmin_gpi-descr.xml   | 10 ++++++++
 xmldoc/formats/options/garmin_gpi-hide.xml    | 10 ++++++++
 xmldoc/formats/options/garmin_gpi-notes.xml   | 11 +++++++++
 .../formats/options/garmin_gpi-position.xml   |  9 ++++++++
 7 files changed, 85 insertions(+)
 create mode 100644 xmldoc/formats/garmin_gpi.xml
 create mode 100644 xmldoc/formats/options/garmin_gpi-bitmap.xml
 create mode 100644 xmldoc/formats/options/garmin_gpi-category.xml
 create mode 100644 xmldoc/formats/options/garmin_gpi-descr.xml
 create mode 100644 xmldoc/formats/options/garmin_gpi-hide.xml
 create mode 100644 xmldoc/formats/options/garmin_gpi-notes.xml
 create mode 100644 xmldoc/formats/options/garmin_gpi-position.xml

diff --git a/xmldoc/formats/garmin_gpi.xml b/xmldoc/formats/garmin_gpi.xml
new file mode 100644
index 000000000..353a86745
--- /dev/null
+++ b/xmldoc/formats/garmin_gpi.xml
@@ -0,0 +1,23 @@
+<para>
+   The format garmin_gpi supports binary POI (.gpi) files useable
+   on newer Garmin GPS receivers (see also <link linkend="fmt_garmin_poi">garmin_poi</link> for some hints).
+   <ulink url="http://www.garmin.com/support/agree.jsp?id=927">Garmin POI-Loader</ulink> is the standard application that creates GPI's
+   with all possible features.
+</para>
+<para>
+   The layout of GPI files isn't documented and our module was created
+   via reverse engeneering. If you get a problem on reading or writing 
+   a GPI file, please provide that file (mailto:gpsbabel-misc@lists.sourceforge.net).
+</para>
+<para>
+   At this time we don't support special features as "Tour-Guide", alerts or links
+   to sounds and pictures.
+</para>
+<example id="all_garmin_gpi_options">
+  <title>Command showing garmin_gpi output example</title>
+  <para>
+    <userinput>
+      gpsbabel -i gpx -f "My Points.gpx" -o garmin_gpi,category="Nice Restaurants",bitmap=restaurant.bmp,notes -F "My Points.gpi"
+    </userinput>
+  </para>
+</example>
diff --git a/xmldoc/formats/options/garmin_gpi-bitmap.xml b/xmldoc/formats/options/garmin_gpi-bitmap.xml
new file mode 100644
index 000000000..48317bb17
--- /dev/null
+++ b/xmldoc/formats/options/garmin_gpi-bitmap.xml
@@ -0,0 +1,13 @@
+<para>
+   The bitmap (BMP) should be 24x24 (or smaller) and can be in
+   RGB-colors (24- and 32-bit) or 8-bit indexed color format.
+</para>
+<para>
+   A color value of 0xFF00FF (blue=255, green=0, red=255), 
+   also called "Magenta", can be used for transparent areas.
+</para>
+<para>
+  <userinput>
+    gpsbabel -i gpx -f "My Points.gpx" -o garmin_gpi,bitmap="tux.bmp" -F "My Points.gpi"
+  </userinput>
+</para>
diff --git a/xmldoc/formats/options/garmin_gpi-category.xml b/xmldoc/formats/options/garmin_gpi-category.xml
new file mode 100644
index 000000000..4f8c8bfe0
--- /dev/null
+++ b/xmldoc/formats/options/garmin_gpi-category.xml
@@ -0,0 +1,9 @@
+<para>
+    With this option you can specify the category which is primary
+    visible on the device (default is "My points").
+</para>
+<para>
+  <userinput>
+    gpsbabel -i gpx -f "My Points.gpx" -o garmin_gpi,category="Best Restaurants" -F "My Points.gpi"
+  </userinput>
+</para>
diff --git a/xmldoc/formats/options/garmin_gpi-descr.xml b/xmldoc/formats/options/garmin_gpi-descr.xml
new file mode 100644
index 000000000..6bcd4e4c1
--- /dev/null
+++ b/xmldoc/formats/options/garmin_gpi-descr.xml
@@ -0,0 +1,10 @@
+<para>
+   The GPI address field is often visible in lists on the device. Use this
+   option if you want to see the waypoint description (which can be an address too)
+   in this lists.
+</para>
+<para>
+  <userinput>
+    gpsbabel -i gpx -f "My Points.gpx" -o garmin_gpi,descr -F "My Points.gpi"
+  </userinput>
+</para>
diff --git a/xmldoc/formats/options/garmin_gpi-hide.xml b/xmldoc/formats/options/garmin_gpi-hide.xml
new file mode 100644
index 000000000..bed5ff9df
--- /dev/null
+++ b/xmldoc/formats/options/garmin_gpi-hide.xml
@@ -0,0 +1,10 @@
+<para>
+   For a large list of points (or whyever) it can be useful when
+   no bitmaps are displayed on device. With this option no bitmap
+   is stored and displayed.
+</para>
+<para>
+  <userinput>
+    gpsbabel -i gpx -f "My Points.gpx" -o garmin_gpi,hide -F "My Points.gpi"
+  </userinput>
+</para>
diff --git a/xmldoc/formats/options/garmin_gpi-notes.xml b/xmldoc/formats/options/garmin_gpi-notes.xml
new file mode 100644
index 000000000..c9d5382b6
--- /dev/null
+++ b/xmldoc/formats/options/garmin_gpi-notes.xml
@@ -0,0 +1,11 @@
+<para>
+   The GPI address field is often visible in lists on the device. Use this
+   option if you want to see the waypoint notes (which can be an address too)
+   in this lists.
+</para>
+<para>
+  <userinput>
+    gpsbabel -i gpx -f "My Points.gpx" -o garmin_gpi,notes -F "My Points.gpi"
+  </userinput>
+</para>
+
diff --git a/xmldoc/formats/options/garmin_gpi-position.xml b/xmldoc/formats/options/garmin_gpi-position.xml
new file mode 100644
index 000000000..0ce0a1006
--- /dev/null
+++ b/xmldoc/formats/options/garmin_gpi-position.xml
@@ -0,0 +1,9 @@
+<para>
+   The GPI address field is often visible in lists on the device. Use this
+   option if you want to see the waypoint position (coordinates) in this lists.
+</para>
+<para>
+  <userinput>
+    gpsbabel -i gpx -f "My Points.gpx" -o garmin_gpi,position -F "My Points.gpi"
+  </userinput>
+</para>
-- 
2.30.2